Exports no GDScript

您所在的位置：网站首页 › compiling shader › Exports no GDScript

Exports no GDScript

2023-04-01 01:14| 来源: 网络整理| 查看: 265

Exports no GDScript露 Introdu莽茫o a exports露

No Godot, membros de classe podem ser exportados. Isso significa que seus valores s茫o salvos junto com o recurso (por exemplo, a cena) a que est茫o anexados. Eles tamb茅m ficar茫o dispon铆veis para edi莽茫o no editor de propriedades. A exporta莽茫o 茅 feita pela palavra-chave export:

extends Button export var number = 5 # Value will be saved and visible in the property editor.

Uma vari谩vel exportada deve inicializada por uma express茫o constante ou ter uma infer锚ncia de exporta莽茫o na forma de um argumento da palavra-chave export (veja abaixo a se莽茫o Exemplos).

Um dos benef铆cios fundamentais de exportar vari谩veis membros 茅 t锚-las vis铆veis e edit谩veis no editor. Dessa forma, artistas e projetistas de jogos podem modificar valores que influenciam como o programa funciona. Para isso, h谩 uma sintaxe especial para exporta莽茫o.

Nota

Exporting properties can also be done in other languages such as C#. The syntax varies depending on the language.

Exemplos露 # If the exported value assigns a constant or constant expression, # the type will be inferred and used in the editor. export var number = 5 # Export can take a basic data type as an argument, which will be # used in the editor. export(int) var number # Export can also take a resource type to use as a hint. export(Texture) var character_face export(PackedScene) var scene_file # There are many resource types that can be used this way, try e.g. # the following to list them: export(Resource) var resource # Integers and strings hint enumerated values. # Editor will enumerate as 0, 1 and 2. export(int, "Warrior", "Magician", "Thief") var character_class # Editor will enumerate with string names. export(String, "Rebecca", "Mary", "Leah") var character_name # Named enum values # Editor will enumerate as THING_1, THING_2, ANOTHER_THING. enum NamedEnum {THING_1, THING_2, ANOTHER_THING = -1} export(NamedEnum) var x # Strings as paths # String is a path to a file. export(String, FILE) var f # String is a path to a directory. export(String, DIR) var f # String is a path to a file, custom filter provided as hint. export(String, FILE, "*.txt") var f # Using paths in the global filesystem is also possible, # but only in scripts in "tool" mode. # String is a path to a PNG file in the global filesystem. export(String, FILE, GLOBAL, "*.png") var tool_image # String is a path to a directory in the global filesystem. export(String, DIR, GLOBAL) var tool_dir # The MULTILINE setting tells the editor to show a large input # field for editing over multiple lines. export(String, MULTILINE) var text # Limiting editor input ranges # Allow integer values from 0 to 20. export(int, 20) var i # Allow integer values from -10 to 20. export(int, -10, 20) var j # Allow floats from -10 to 20 and snap the value to multiples of 0.2. export(float, -10, 20, 0.2) var k # Allow values 'y = exp(x)' where 'y' varies between 100 and 1000 # while snapping to steps of 20. The editor will present a # slider for easily editing the value. export(float, EXP, 100, 1000, 20) var l # Floats with easing hint # Display a visual representation of the 'ease()' function # when editing. export(float, EASE) var transition_speed # Colors # Color given as red-green-blue value (alpha will always be 1). export(Color, RGB) var col # Color given as red-green-blue-alpha value. export(Color, RGBA) var col # Nodes # Another node in the scene can be exported as a NodePath. export(NodePath) var node_path # Do take note that the node itself isn't being exported - # there is one more step to call the true node: onready var node = get_node(node_path) # Resources export(Resource) var resource # In the Inspector, you can then drag and drop a resource file # from the FileSystem dock into the variable slot. # Opening the inspector dropdown may result in an # extremely long list of possible classes to create, however. # Therefore, if you specify an extension of Resource such as: export(AnimationNode) var resource # The drop-down menu will be limited to AnimationNode and all # its inherited classes.

Perceba que mesmo se o script n茫o estiver em execu莽茫o enquanto estiver no editor, as propriedades exportadas ainda s茫o edit谩veis. Isso pode ser usado em conjunto com um script em modo "tool".

Exportando sinalizadores de bits露

Inteiros usados como sinalizadores podem armazenar m煤ltiplos valores true/false (booleanos) em uma propriedade. Usando a infer锚ncia de exporta莽茫o int, FLAGS, ..., eles podem ser configurados a partir do editor:

# Set any of the given flags from the editor. export(int, FLAGS, "Fire", "Water", "Earth", "Wind") var spell_elements = 0

Voc锚 deve fornecer uma descri莽茫o em string para cada sinalizador. Neste exemplo, Fire tem valor 1, Water tem valor 2, Earth tem valor 4 e Wind corresponde ao valor 8. Normalmente, constantes deveriam ser definidas em conformidade (por exemplo, const ELEMENT_WIND = 8 e assim por diante).

Infer锚ncias de exporta莽茫o tamb茅m s茫o fornecidas para as camadas de f铆sica e de renderiza莽茫o definidas nas configura莽玫es do projeto:

export(int, LAYERS_2D_PHYSICS) var layers_2d_physics export(int, LAYERS_2D_RENDER) var layers_2d_render export(int, LAYERS_3D_PHYSICS) var layers_3d_physics export(int, LAYERS_3D_RENDER) var layers_3d_render

O uso de sinalizadores de bit exige certo conhecimento de opera莽玫es bit a bit. Na d煤vida, exporte vari谩veis booleanas.

Exportando arrays露

Arrays exportados podem ter inicializadores, mas devem ser express玫es constantes.

Se o array exportado especificar um tipo que herda de Resource, os valores do array podem ser definidos no inspetor arrastando e soltando v谩rios arquivos da dock Arquivos de uma vez.

# Default value must be a constant expression. export var a = [1, 2, 3] # Exported arrays can specify type (using the same hints as before). export(Array, int) var ints = [1, 2, 3] export(Array, int, "Red", "Green", "Blue") var enums = [2, 1, 0] export(Array, Array, float) var two_dimensional = [[1.0, 2.0], [3.0, 4.0]] # You can omit the default value, but then it would be null if not assigned. export(Array) var b export(Array, PackedScene) var scenes # Arrays with specified types which inherit from resource can be set by # drag-and-dropping multiple files from the FileSystem dock. export(Array, Texture) var textures export(Array, PackedScene) var scenes # Typed arrays also work, only initialized empty: export var vector3s = PoolVector3Array() export var strings = PoolStringArray() # Default value can include run-time values, but can't # be exported. var c = [a, 2, 3] Definindo vari谩veis exportadas a partir de um script de ferramenta露

Ao alterar o valor de uma vari谩vel exportada de um script em Modo de Ferramenta, o valor no inspetor n茫o ser谩 atualizado automaticamente. Para atualiz谩-lo chame property_list_changed_notify() ap贸s definir o valor da vari谩vel exportada.

Exports avan莽ados露

Nem todo tipo de export pode ser fornecido no n铆vel da pr贸pria linguagem para evitar complexidade de design desnecess谩ria. O seguinte descreve mais ou menos alguns recursos de exporta莽茫o comuns que podem ser implementados com uma API de baixo n铆vel.

Antes de continuar lendo, voc锚 deve se familiarizar com a forma como propriedades s茫o tratadas e como elas podem ser personalizadas com os m茅todos _set(), _get(), e _get_property_list() como descrito em Acessando dados ou l贸gica a partir de um objeto.

Ver tamb茅m

Para propriedades de liga莽茫o usando os m茅todos acima em C++, veja Binding properties using _set/_get/_get_property_list.

Aviso

O script deve operar no modo de ferramenta para que os m茅todos acima possam funcionar dentro do editor.

Propriedades露

To understand how to better use the sections below, you should understand how to make properties with advanced exports.

func _get_property_list(): var properties = [] # Same as "export(int) var my_property" properties.append({ name = "my_property", type = TYPE_INT }) return properties

The _get_property_list() function gets called by the inspector. You can override it for more advanced exports. You must return an Array with the contents of the properties for the function to work.

name 茅 o nome de uma categoria a ser adicionada ao inspetor

type is the type of the property from Variant.Type.

Nota

The float type is called a real (TYPE_REAL) in the Variant.Type enum.

Anexando vari谩veis a propriedades露

To attach variables to properties (allowing the value of the property to be used in scripts), you need to create a variable with the exact same name as the property or else you may need to override the _set() and _get() methods. Attaching a variable to to a property also gives you the ability to give it a default state.

# This variable is determined by the function below. # This variable acts just like a regular gdscript export. var my_property = 5 func _get_property_list(): var properties = [] # Same as "export(int) var my_property" properties.append({ name = "my_property", type = TYPE_INT }) return properties Adding default values for properties露

To define default values for advanced exports, you need to override the property_can_revert() and property_get_revert() methods.

The property_can_revert() method takes the name of a property and must return true if the property can be reverted. This will enable the Revert button next to the property in the inspector.

The property_get_revert() method takes the name of a property and must return the default value for that property.

func _get_property_list(): var properties = [] properties.append({ name = "my_property", type = TYPE_INT }) return properties func property_can_revert(property): if property == "my_property": return true return false func property_get_revert(property): if property == "my_property": return 5 Adicionando categorias de script露

Para melhor distin莽茫o visual das propriedades, uma categoria de script especial pode ser incorporada ao inspetor para atuar como separador. Vari谩veis de Script s茫o um exemplo de uma categoria embutida.

func _get_property_list(): var properties = [] properties.append({ name = "Debug", type = TYPE_NIL, usage = PROPERTY_USAGE_CATEGORY | PROPERTY_USAGE_SCRIPT_VARIABLE }) # Example of adding a property to the script category properties.append({ name = "Logging_Enabled", type = TYPE_BOOL }) return properties

name 茅 o nome de uma categoria a ser adicionada ao inspetor;

Every following property added after the category definition will be a part of the category.

PROPERTY_USAGE_CATEGORY indica que a propriedade deve ser tratada como uma categoria de script especificamente, ent茫o o tipo TYPE_NIL pode ser ignorado pois n茫o ser谩 realmente usado para a l贸gica de script, mas deve ser definido de qualquer forma.

Agrupando propriedades露

Uma lista de propriedades com nomes semelhantes pode ser agrupada.

func _get_property_list(): var properties = [] properties.append({ name = "Rotate", type = TYPE_NIL, hint_string = "rotate_", usage = PROPERTY_USAGE_GROUP | PROPERTY_USAGE_SCRIPT_VARIABLE }) # Example of adding to the group properties.append({ name = "rotate_speed", type = TYPE_REAL }) # This property won't get added to the group # due to not having the "rotate_" prefix. properties.append({ name = "trail_color", type = TYPE_COLOR }) return properties

name 茅 o nome de um grupo que ser谩 exibido como uma lista de propriedades que pode ser recolhida;

Every following property added after the group property with the prefix (which determined by hint_string) will be shortened. For instance, rotate_speed is going to be shortened to speed in this case. However, movement_speed won't be a part of the group and will not be shortened.

PROPERTY_USAGE_GROUP indica que a propriedade deve ser tratada como um grupo de script especificamente, ent茫o o tipo TYPE_NIL pode ser ignorado, pois n茫o ser谩 realmente usado para a l贸gica de script, mas deve ser definido de qualquer forma.

【本文地址】

公司简介

联系我们